/*
 * Copyright 2017 ~ 2025 the original author or authors. James Wong <jameswong1376@gmail.com>>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.wl4g.infra.common.remoting;

import java.io.Closeable;
import java.io.IOException;

import com.wl4g.infra.common.remoting.parse.HttpInputMessage;
import com.wl4g.infra.common.remoting.standard.HttpStatus;

/**
 * Represents a client-side HTTP response. Obtained via an calling of the
 * {@link ClientHttpRequest#execute()}.
 *
 * <p>
 * A {@code ClientHttpResponse} must be {@linkplain #close() closed}, typically
 * in a {@code finally} block.
 *
 */
public interface ClientHttpResponse extends HttpInputMessage, Closeable {

    /**
     * Return the HTTP status code as an {@link HttpStatus} enum value.
     * 
     * @return the HTTP status as an HttpStatus enum value (never {@code null})
     * @throws IOException
     *             in case of I/O errors
     * @throws IllegalArgumentException
     *             in case of an unknown HTTP status code
     * @since #getRawStatusCode()
     * @see HttpStatus#valueOf(int)
     */
    HttpStatus getStatusCode() throws IOException;

    /**
     * Return the HTTP status code (potentially non-standard and not resolvable
     * through the {@link HttpStatus} enum) as an integer.
     * 
     * @return the HTTP status as an integer value
     * @throws IOException
     *             in case of I/O errors
     * @since 3.1.1
     * @see #getStatusCode()
     * @see HttpStatus#resolve(int)
     */
    int getRawStatusCode() throws IOException;

    /**
     * Return the HTTP status text of the response.
     * 
     * @return the HTTP status text
     * @throws IOException
     *             in case of I/O errors
     */
    String getStatusText() throws IOException;

    /**
     * Close this response, freeing any resources created.
     */
    @Override
    void close();

}